home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qiodevice.Z / qiodevice
Encoding:
Text File  |  1998-10-28  |  29.4 KB  |  595 lines

  1.  
  2.  
  3.  
  4.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       QIODevice - The base class of    I/O devices
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <qiodevice.h>
  13.  
  14.       Inherited by QBuffer and QFile.
  15.  
  16.     PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
  17.       QQQQIIIIOOOODDDDeeeevvvviiiicccceeee (((())))
  18.       vvvviiiirrrrttttuuuuaaaallll ~~~~QQQQIIIIOOOODDDDeeeevvvviiiicccceeee ()
  19.       iiiinnnntttt ffffllllaaaaggggssss (((()))) ccccoooonnnnsssstttt
  20.       iiiinnnntttt mmmmooooddddeeee (((()))) ccccoooonnnnsssstttt
  21.       iiiinnnntttt ssssttttaaaatttteeee (((()))) ccccoooonnnnsssstttt
  22.       bbbboooooooollll iiiissssDDDDiiiirrrreeeeccccttttAAAAcccccccceeeessssssss (((()))) ccccoooonnnnsssstttt
  23.       bbbboooooooollll iiiissssSSSSeeeeqqqquuuueeeennnnttttiiiiaaaallllAAAAcccccccceeeessssssss (((()))) ccccoooonnnnsssstttt
  24.       bbbboooooooollll iiiissssCCCCoooommmmbbbbiiiinnnneeeeddddAAAAcccccccceeeessssssss    (((()))) ccccoooonnnnsssstttt
  25.       bbbboooooooollll iiiissssBBBBuuuuffffffffeeeerrrreeeedddd (((()))) ccccoooonnnnsssstttt
  26.       bbbboooooooollll iiiissssRRRRaaaawwww (((())))    ccccoooonnnnsssstttt
  27.       bbbboooooooollll iiiissssSSSSyyyynnnncccchhhhrrrroooonnnnoooouuuussss (((())))    ccccoooonnnnsssstttt
  28.       bbbboooooooollll iiiissssAAAAssssyyyynnnncccchhhhrrrroooonnnnoooouuuussss (((()))) ccccoooonnnnsssstttt
  29.       bbbboooooooollll iiiissssTTTTrrrraaaannnnssssllllaaaatttteeeedddd (((()))) ccccoooonnnnsssstttt
  30.       bbbboooooooollll iiiissssRRRReeeeaaaaddddaaaabbbblllleeee (((()))) ccccoooonnnnsssstttt
  31.       bbbboooooooollll iiiissssWWWWrrrriiiittttaaaabbbblllleeee (((()))) ccccoooonnnnsssstttt
  32.       bbbboooooooollll iiiissssRRRReeeeaaaaddddWWWWrrrriiiitttteeee (((()))) ccccoooonnnnsssstttt
  33.       bbbboooooooollll iiiissssIIIInnnnaaaaccccttttiiiivvvveeee (((()))) ccccoooonnnnsssstttt
  34.       bbbboooooooollll iiiissssOOOOppppeeeennnn (((()))) ccccoooonnnnsssstttt
  35.       iiiinnnntttt ssssttttaaaattttuuuussss (((())))    ccccoooonnnnsssstttt
  36.       vvvvooooiiiidddd rrrreeeesssseeeettttSSSSttttaaaattttuuuussss (((())))
  37.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll ooooppppeeeennnn (((( iiiinnnntttt mmmmooooddddeeee ))))
  38.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd cccclllloooosssseeee (((())))
  39.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd fffflllluuuusssshhhh (((())))
  40.       vvvviiiirrrrttttuuuuaaaallll uuuuiiiinnnntttt ssssiiiizzzzeeee (((()))) ccccoooonnnnsssstttt
  41.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt aaaatttt (((()))) ccccoooonnnnsssstttt
  42.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll aaaatttt (((( iiiinnnntttt    ))))
  43.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll aaaattttEEEEnnnndddd (((())))    ccccoooonnnnsssstttt
  44.       bbbboooooooollll rrrreeeesssseeeetttt (((())))
  45.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt rrrreeeeaaaaddddBBBBlllloooocccckkkk    (((( cccchhhhaaaarrrr **** _d_a_t_a,,,, uuuuiiiinnnntttt lllleeeennnn    ))))
  46.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt wwwwrrrriiiitttteeeeBBBBlllloooocccckkkk (((( ccccoooonnnnsssstttt cccchhhhaaaarrrr ****    _d_a_t_a,,,, uuuuiiiinnnntttt lllleeeennnn ))))
  47.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt rrrreeeeaaaaddddLLLLiiiinnnneeee (((( cccchhhhaaaarrrr ****    _d_a_t_a,,,, uuuuiiiinnnntttt mmmmaaaaxxxxlllleeeennnn ))))
  48.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt ggggeeeettttcccchhhh (((())))
  49.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt ppppuuuuttttcccchhhh (((( iiiinnnntttt ))))
  50.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt uuuunnnnggggeeeettttcccchhhh ((((    iiiinnnntttt ))))
  51.  
  52.     PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
  53.       vvvvooooiiiidddd sssseeeettttFFFFllllaaaaggggssss    (((( iiiinnnntttt ffff    ))))
  54.       vvvvooooiiiidddd sssseeeettttTTTTyyyyppppeeee (((( iiiinnnntttt ))))
  55.       vvvvooooiiiidddd sssseeeettttMMMMooooddddeeee (((( iiiinnnntttt ))))
  56.       vvvvooooiiiidddd sssseeeettttSSSSttttaaaatttteeee    (((( iiiinnnntttt ))))
  57.       vvvvooooiiiidddd sssseeeettttSSSSttttaaaattttuuuussss (((( iiiinnnntttt ))))
  58.  
  59.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                         ((((pppprrrriiiinnnntttteeeedddd 9999////22222222////99998888))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  71.  
  72.  
  73.  
  74.       The QIODevice    class is the base class    of I/O devices.
  75.  
  76.       An I/O device    represents a medium that one can read bytes
  77.       from and write bytes to. The QIODevice class itself is not
  78.       capable of reading or    writing    any data; it has virtual
  79.       functions for    doing so. These    functions are implemented by
  80.       the subclasses QFile and QBuffer.
  81.  
  82.       There    are two    types of I/O devices; <em>direct access</em>
  83.       and <em>sequential access </em> devices. Files can normally
  84.       be accessed directly,    except stdin etc., which must be
  85.       processed sequentially. Buffers are always direct access
  86.       devices.
  87.  
  88.       The access mode of an    I/O device can be either _r_a_w or
  89.       _b_u_f_f_e_r_e_d. QFile objects can be created using one of these.
  90.       Raw access mode is more low level, while buffered access use
  91.       smart    buffering techniques. The raw access mode is best when
  92.       I/O is block-operated    using 4kB block    size or    greater.
  93.       Buffered access works    better when reading small portions of
  94.       data at a time.
  95.  
  96.       An I/O device    operation can be executed in either
  97.       _s_y_n_c_h_r_o_n_o_u_s or _a_s_y_n_c_h_r_o_n_o_u_s mode. The    I/O devices currently
  98.       supported by Qt only execute synchronously.
  99.  
  100.       The QDataStream and QTextStream provide binary and text
  101.       operations on    QIODevice objects.
  102.  
  103.       QIODevice provides numerous pure virtual functions you need
  104.       to implement when subclassing    it. Here is a skeleton
  105.       subclass:
  106.  
  107.           class YourDevice : public    QIODevice
  108.           {
  109.           public:
  110.           YourDevice();
  111.          ~YourDevice();
  112.           bool open( int mode );
  113.           void close();
  114.           void flush();
  115.           uint size() const;
  116.           int  at() const;      // not a pure    virtual    function
  117.           bool at( int );      // not a pure    virtual    function
  118.           bool atEnd() const;      // not a pure    virtual    function
  119.           int readBlock( char *data, uint len );
  120.           int writeBlock( const    char *data, uint len );
  121.           int readLine(    char *data, uint maxlen    );
  122.           int getch();
  123.           int putch( int );
  124.           int ungetch( int );
  125.           };
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 9/22/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  137.  
  138.  
  139.  
  140.       The three non-pure virtual functions can be ignored if your
  141.       device is sequential (e.g. a tape device).
  142.  
  143.       See also: QDataStream    and QTextStream.
  144.  
  145.      MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  146.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::QQQQIIIIOOOODDDDeeeevvvviiiicccceeee (((())))
  147.       Constructs an    I/O device.
  148.  
  149.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::~~~~QQQQIIIIOOOODDDDeeeevvvviiiicccceeee (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  150.       Destroys the I/O device.
  151.  
  152.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::aaaatttt    (((( iiiinnnntttt ppppoooossss )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  153.       Virtual function that    sets the I/O device index to _p_o_s.
  154.  
  155.       See also: size().
  156.  
  157.       Reimplemented    in QBuffer and QFile.
  158.  
  159.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::aaaatttt (((()))) ccccoooonnnnsssstttt    [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  160.       Virtual function that    returns    the current I/O    device index.
  161.  
  162.       This index is    the data read/write head of the    I/O device.
  163.  
  164.       See also: size().
  165.  
  166.       Reimplemented    in QBuffer and QFile.
  167.  
  168.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::aaaattttEEEEnnnndddd (((()))) ccccoooonnnnsssstttt [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  169.       Virtual function that    returns    TRUE if    the I/O    device index
  170.       is at    the end    of the input.
  171.  
  172.       Reimplemented    in QFile.
  173.  
  174.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::cccclllloooosssseeee (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  175.       Closes the I/O device.
  176.  
  177.       This virtual function    must be    reimplemented by all
  178.       subclasses.
  179.  
  180.       See also: open().
  181.  
  182.       Reimplemented    in QBuffer and QFile.
  183.  
  184.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ffffllllaaaaggggssss (((()))) ccccoooonnnnsssstttt
  185.       Returns the current I/O device flags setting.
  186.  
  187.       Flags    consists of mode flags and state flags.
  188.  
  189.       See also: mode() and state().
  190.  
  191.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::fffflllluuuusssshhhh (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  192.  
  193.  
  194.  
  195.      PPPPaaaaggggeeee 3333                         ((((pppprrrriiiinnnntttteeeedddd 9999////22222222////99998888))))
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  203.  
  204.  
  205.  
  206.       Flushes an open I/O device.
  207.  
  208.       This virtual function    must be    reimplemented by all
  209.       subclasses.
  210.  
  211.       Reimplemented    in QBuffer and QFile.
  212.  
  213.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ggggeeeettttcccchhhh (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  214.       Reads    a single byte/character    from the I/O device.
  215.  
  216.       Returns the byte/character read, or -1 if the    end of the I/O
  217.       device has been reached.
  218.  
  219.       This virtual function    must be    reimplemented by all
  220.       subclasses.
  221.  
  222.       See also: putch() and    ungetch().
  223.  
  224.       Reimplemented    in QBuffer and QFile.
  225.  
  226.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssAAAAssssyyyynnnncccchhhhrrrroooonnnnoooouuuussss (((()))) ccccoooonnnnsssstttt
  227.       Returns TRUE if the I/O device is a asynchronous device,
  228.       otherwise FALSE.
  229.  
  230.       This mode is currently not in    use.
  231.  
  232.       See also: isSynchronous().
  233.  
  234.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssBBBBuuuuffffffffeeeerrrreeeedddd    (((()))) ccccoooonnnnsssstttt
  235.       Returns TRUE if the I/O device is a buffered (not raw)
  236.       device, otherwise FALSE.
  237.  
  238.       See also: isRaw().
  239.  
  240.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssCCCCoooommmmbbbbiiiinnnneeeeddddAAAAcccccccceeeessssssss (((()))) ccccoooonnnnsssstttt
  241.       Returns TRUE if the I/O device is a combined access (both
  242.       direct and sequential) device, otherwise FALSE.
  243.  
  244.       This access method is    currently not in use.
  245.  
  246.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssDDDDiiiirrrreeeeccccttttAAAAcccccccceeeessssssss (((()))) ccccoooonnnnsssstttt
  247.       Returns TRUE if the I/O device is a direct access (not
  248.       sequential) device, otherwise    FALSE.
  249.  
  250.       See also: isSequentialAccess().
  251.  
  252.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssIIIInnnnaaaaccccttttiiiivvvveeee    (((()))) ccccoooonnnnsssstttt
  253.       Returns TRUE if the I/O device state is 0, i.e. the device
  254.       is not open.
  255.  
  256.       See also: isOpen().
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                         (printed 9/22/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  269.  
  270.  
  271.  
  272.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssOOOOppppeeeennnn (((()))) ccccoooonnnnsssstttt
  273.       Returns TRUE if the I/O device state has been    opened,
  274.       otherwise FALSE.
  275.  
  276.       See also: isInactive().
  277.  
  278.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssRRRRaaaawwww (((()))) ccccoooonnnnsssstttt
  279.       Returns TRUE if the I/O device is a raw (not buffered)
  280.       device, otherwise FALSE.
  281.  
  282.       See also: isBuffered().
  283.  
  284.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssRRRReeeeaaaaddddWWWWrrrriiiitttteeee (((()))) ccccoooonnnnsssstttt
  285.       Returns TRUE if the I/O device was opened using IO_ReadWrite
  286.       mode.
  287.  
  288.       See also: isReadable() and isWritable().
  289.  
  290.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssRRRReeeeaaaaddddaaaabbbblllleeee    (((()))) ccccoooonnnnsssstttt
  291.       Returns TRUE if the I/O device was opened using IO_ReadOnly
  292.       or IO_ReadWrite mode.
  293.  
  294.       See also: isWritable() and isReadWrite().
  295.  
  296.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssSSSSeeeeqqqquuuueeeennnnttttiiiiaaaallllAAAAcccccccceeeessssssss    (((()))) ccccoooonnnnsssstttt
  297.       Returns TRUE if the I/O device is a sequential access    (not
  298.       direct) device, otherwise FALSE. Operations involving    size()
  299.       and at(int) are not valid on sequential devices.
  300.  
  301.       See also: isDirectAccess().
  302.  
  303.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssSSSSyyyynnnncccchhhhrrrroooonnnnoooouuuussss (((()))) ccccoooonnnnsssstttt
  304.       Returns TRUE if the I/O device is a synchronous device,
  305.       otherwise FALSE.
  306.  
  307.       See also: isAsynchronous().
  308.  
  309.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssTTTTrrrraaaannnnssssllllaaaatttteeeedddd (((()))) ccccoooonnnnsssstttt
  310.       Returns TRUE if the I/O device translates carriage-return
  311.       and linefeed characters.
  312.  
  313.       A QFile is translated    if it is opened    with the IO_Translate
  314.       mode flag.
  315.  
  316.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::iiiissssWWWWrrrriiiittttaaaabbbblllleeee    (((()))) ccccoooonnnnsssstttt
  317.       Returns TRUE if the I/O device was opened using IO_WriteOnly
  318.       or IO_ReadWrite mode.
  319.  
  320.       See also: isReadable() and isReadWrite().
  321.  
  322.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::mmmmooooddddeeee (((()))) ccccoooonnnnsssstttt
  323.       Returns bits OR'ed together that specify the current
  324.  
  325.  
  326.  
  327.      Page 5                         (printed 9/22/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  335.  
  336.  
  337.  
  338.       operation mode.
  339.  
  340.       These    are the    flags that were    given to the open() function.
  341.  
  342.       The flags are: IO_ReadOnly, IO_WriteOnly, IO_ReadWrite,
  343.       IO_Append, IO_Truncate and IO_Translate.
  344.  
  345.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ooooppppeeeennnn (((( iiiinnnntttt    mmmmooooddddeeee )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  346.       Opens    the I/O    device using the specified _m_o_d_e. Returns TRUE
  347.       if successful, or FALSE if the device    could not be opened.
  348.  
  349.       The mode parameter _m must be a combination of    the following
  350.       flags.
  351.  
  352.       IO_Raw specified raw (unbuffered) file access.
  353.  
  354.       IO_ReadOnly opens a file in read-only    mode.
  355.  
  356.       IO_WriteOnly opens a file in write-only mode.
  357.  
  358.       IO_ReadWrite opens a file in read/write mode.
  359.  
  360.       IO_Append sets the file index    to the end of the file.
  361.  
  362.       IO_Truncate truncates    the file.
  363.  
  364.      for text files under MS-DOS, Window, OS/2 and Macintosh. Cannot
  365.      be    combined with IO_Raw.
  366.       IO_Translate enables carriage    returns    and linefeed translation
  367.  
  368.       This virtual function    must be    reimplemented by all
  369.       subclasses.
  370.  
  371.       See also: close().
  372.  
  373.       Reimplemented    in QBuffer and QFile.
  374.  
  375.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ppppuuuuttttcccchhhh (((( iiiinnnntttt    cccchhhh )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  376.       Writes the character _c_h to the I/O device.
  377.  
  378.       Returns _c_h, or -1 if some error occurred.
  379.  
  380.       This virtual function    must be    reimplemented by all
  381.       subclasses.
  382.  
  383.       See also: getch() and    ungetch().
  384.  
  385.       Reimplemented    in QBuffer and QFile.
  386.  
  387.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::rrrreeeeaaaaddddBBBBlllloooocccckkkk ((((    cccchhhhaaaarrrr **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt lllleeeennnn ))))    [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  388.       Reads    at most    _l_e_n bytes from the I/O device into _d_a_t_a    and
  389.       returns the number of    bytes actually read.
  390.  
  391.  
  392.  
  393.      Page 6                         (printed 9/22/98)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  401.  
  402.  
  403.  
  404.       This virtual function    must be    reimplemented by all
  405.       subclasses.
  406.  
  407.       See also: writeBlock().
  408.  
  409.       Reimplemented    in QBuffer and QFile.
  410.  
  411.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::rrrreeeeaaaaddddLLLLiiiinnnneeee (((( cccchhhhaaaarrrr **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt mmmmaaaaxxxxlllleeeennnn    )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  412.       Reads    a line of text,    up to _m_a_x_l_e_n bytes including a
  413.       terminating \0. If there is a    newline    at the end if the
  414.       line,    it is not stripped.
  415.  
  416.       Returns the number of    bytes read, or -1 in case of error.
  417.  
  418.       This virtual function    can be reimplemented much more
  419.       efficiently by the most subclasses.
  420.  
  421.       See also: readBlock()    and QTextStream::readLine().
  422.  
  423.       Reimplemented    in QBuffer and QFile.
  424.  
  425.      bbbboooooooollll QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::rrrreeeesssseeeetttt (((())))
  426.       Sets the device index    to 0.
  427.  
  428.       See also: at().
  429.  
  430.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::rrrreeeesssseeeettttSSSSttttaaaattttuuuussss (((())))
  431.       Sets the I/O device status to    IO_Ok.
  432.  
  433.       See also: status().
  434.  
  435.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::sssseeeettttFFFFllllaaaaggggssss ((((    iiiinnnntttt ffff ))))    [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  436.       For internal use only.
  437.  
  438.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::sssseeeettttMMMMooooddddeeee (((( iiiinnnntttt mmmm )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  439.       For internal use only.
  440.  
  441.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::sssseeeettttSSSSttttaaaatttteeee ((((    iiiinnnntttt ssss ))))    [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  442.       For internal use only.
  443.  
  444.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::sssseeeettttSSSSttttaaaattttuuuussss (((( iiiinnnntttt ssss )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  445.       For internal use only.
  446.  
  447.      vvvvooooiiiidddd QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::sssseeeettttTTTTyyyyppppeeee (((( iiiinnnntttt tttt )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  448.       For internal use only.
  449.  
  450.      uuuuiiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ssssiiiizzzzeeee (((()))) ccccoooonnnnsssstttt [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  451.       Virtual function that    returns    the size of the    I/O device.
  452.  
  453.       See also: at().
  454.  
  455.       Reimplemented    in QBuffer and QFile.
  456.  
  457.  
  458.  
  459.      Page 7                         (printed 9/22/98)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  467.  
  468.  
  469.  
  470.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ssssttttaaaatttteeee (((()))) ccccoooonnnnsssstttt
  471.       Returns bits OR'ed together that specify the current state.
  472.  
  473.       The flags are: IO_Open.
  474.  
  475.       Subclasses may define    more flags.
  476.  
  477.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::ssssttttaaaattttuuuussss (((()))) ccccoooonnnnsssstttt
  478.       Returns the I/O device status.
  479.  
  480.       The I/O device status    returns    an error code. If open()
  481.       returns FALSE    or readBlock() or writeBlock() return -1, this
  482.       function can be called to get    the reason why the operation
  483.       did not succeed.
  484.  
  485.       The status codes are:
  486.  
  487.       IO_Ok    The operation was successful.
  488.  
  489.       IO_ReadError Could not read from the device.
  490.  
  491.       IO_WriteError    Could not write    to the device.
  492.  
  493.       IO_FatalError    A fatal    unrecoverable error occurred.
  494.  
  495.       IO_OpenError Could not open the device.
  496.  
  497.       IO_ConnectError Could    not connect to the device.
  498.  
  499.       IO_AbortError    The operation was unexpectedly aborted.
  500.  
  501.       IO_TimeOutError The operation    timed out.
  502.  
  503.       See also: resetStatus().
  504.  
  505.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::uuuunnnnggggeeeettttcccchhhh (((( iiiinnnntttt cccchhhh )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  506.       Puts the character _c_h    back into the I/O device and
  507.       decrements the index if it is    not zero.
  508.  
  509.       This function    is normally called to "undo" a getch()
  510.       operation.
  511.  
  512.       Returns _c_h, or -1 if some error occurred.
  513.  
  514.       This virtual function    must be    reimplemented by all
  515.       subclasses.
  516.  
  517.       See also: getch() and    putch().
  518.  
  519.       Reimplemented    in QBuffer and QFile.
  520.  
  521.      iiiinnnntttt QQQQIIIIOOOODDDDeeeevvvviiiicccceeee::::::::wwwwrrrriiiitttteeeeBBBBlllloooocccckkkk (((( ccccoooonnnnsssstttt cccchhhhaaaarrrr **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt lllleeeennnn ))))
  522.  
  523.  
  524.  
  525.      PPPPaaaaggggeeee 8888                         ((((pppprrrriiiinnnntttteeeedddd 9999////22222222////99998888))))
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQIIIIOOOODDDDeeeevvvviiiicccceeee((((3333qqqqtttt))))
  533.  
  534.  
  535.  
  536.       [virtual]
  537.       Writes _l_e_n bytes from    _p to the I/O device and    returns    the
  538.       number of bytes actually written.
  539.  
  540.       This virtual function    must be    reimplemented by all
  541.       subclasses.
  542.  
  543.       See also: readBlock().
  544.  
  545.       Reimplemented    in QBuffer and QFile.
  546.  
  547.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  548.       hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqiiiiooooddddeeeevvvviiiicccceeee....hhhhttttmmmmllll
  549.  
  550.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  551.       Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
  552.       included in the distribution for a complete license
  553.       statement.
  554.  
  555.      AAAAUUUUTTTTHHHHOOOORRRR
  556.       Generated automatically from the source code.
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                         (printed 9/22/98)
  592.  
  593.  
  594.  
  595.